extends DirectoryResource
Represents an article in a blog.
An article has a title, body, brief description and blog images. An article is also a folder and can contain resources such as images used in body content
Blog images are images which are specifically assigned to the article with an orientation and they are used for templating purposes.
Articles have an approval process to allow blog authors to have their work checked before being published to the website.
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| title | String | ||
| blogSite | Website | ||
| article | BlogArticle | ||
| availableServices | List | Returns a list of configured social media services. See SocialLoginApp for more details | |
| name | String | ||
| tags | List | Get all tags for the blog | |
| selectedTags | List | Get the selected tags for this article | |
| brief | String | A brief description of the article, normally used in index pages | |
| body | String | The body copy. | |
| categoryTitle | String | The text of the category | |
| category | String | The category that the article is in | |
| blogFiles | List | Gets the blog file resources associated with this blog | |
| images | List |
All images assigned to this article. Does not include images which are
simply in the folder or referenced by body content
Returns items of type Image |
|
| squareImageHref | String | ||
| verticalImageHref | String | ||
| horizontalImageHref | String | ||
| bestDefaultImageHref | String | ||
| bestSquareImageHref | String | ||
| bestVerticalImageHref | String | ||
| bestHorizontalImageHref | String | ||
| externalUrl | String | ||
| articleDate | String | ||
| articleDateDate | Date | ||
| rejectedReason | String | ||
| rejectedAt | Date | ||
| rejectedBy | ProfileBean | ||
| submittedDate | Date | ||
| submittedBy | ProfileBean | ||
| publishedDate | Date | When the article was published, or null if not currently published | |
| publishedBy | ProfileBean | Who publised this article | |
| groups | Set | The groups to filter visibility by. Returns an empty list if none selected , which implies visibility to all groups | |
| allGroups | List | All groups defined by the organisation | |
| paramNames | List | ||
| comments | List | ||
| theme | Theme | ||
| seoContent | SeoContentBean |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| isInTargetGroup ( p ) | boolean |
If this article has a group filter, then only return true if the user is
in a specified group.
If no group filter has been applied then return true |
|
| isSelectedTag ( tags ) | boolean |
Are any of the given tags selected for this article
If tags is null or empty returns true |
|
| isSelected ( tags, categories ) | boolean | Check if selected tags and categories match. If either is null or empty is ignored. Only returns true if there is a successful match on both tags and categories | |
| isSelectedTag ( tag ) | boolean | True if the given argument is the name of a selected tag | |
| isSelected ( g ) | boolean | Is the given group selected for visibility of this article | |
| isSelected ( groupName ) | boolean |
Ask a question, or offer an answer